home *** CD-ROM | disk | FTP | other *** search
/ Suzy B Software 2 / Suzy B Software CD-ROM 2 (1994).iso / bootup / boot_n2z / play20 / play.doc < prev    next >
Text File  |  1995-05-02  |  10KB  |  304 lines
  1.  
  2.  
  3.  
  4.                                  QD Play
  5.                    Version 2.0
  6.                  By Dave Baggett
  7.  
  8.             Copyright (C) 1990, 1991, 1992 by David M. Baggett                   
  9.  
  10. --------------------------------------------------------------------------------
  11.                   User Contract
  12.  
  13. This program is FREE.  You may distribute it at will, provided you
  14.     
  15.     1) do not charge any money for it,
  16.     2) distribute it WITH the documentation, and
  17.     3) do not change the program or documentation in ANY WAY.
  18.  
  19. --------------------------------------------------------------------------------
  20.  
  21.   
  22. Command Line Usage
  23. ------------------
  24.  
  25.    This utility will play 8-bit sound samples.  To call it from a 
  26. command shell (e.g. GULAM), type
  27.  
  28.     play <pathname> <Hz>
  29.  
  30. where <pathname> is the name of the sample file, and <Hz> is the 
  31. playback frequency in Hertz.  For example, type
  32.  
  33.     play deadjim.snd 11000
  34.  
  35. and you will hear Bones and Captain Kirk.  Note that the program 
  36. doesn't care how fast or slow you play the sample, so try
  37.  
  38.     play deadjim.snd 18000
  39.  
  40. and
  41.  
  42.     play deadjim.snd 7500
  43.  
  44. to see the effect of changing the playback speed.
  45.  
  46.  
  47. AUTO Folder usage
  48. -----------------
  49.  
  50.    Isn't it *nifty* how those Mac people can make their computers play
  51. digitized sounds when they boot up?  Well, now you too can experience
  52. the tremendous joy of hearing your machine make some obnoxious noise
  53. when you turn it on.  Here's how:
  54.  
  55.    Put play.prg in your AUTO folder.  Use autosort to make play.prg
  56. the first thing to get called on bootup.  You can do this by hand
  57. by saving a copy of your AUTO programs, deleting your AUTO folder, 
  58. then copying the AUTO programs into a fresh AUTO folder in the 
  59. order in which you want the AUTO programs to be called.  (For all
  60. you programmer types: NO it's not a requirement that play.prg get
  61. called first, it's just more Mac-ish that way.)
  62.  
  63.    Then create a file called play.inf with a text editor containing 
  64. lines like
  65.  
  66.     <pathname> <Hz>
  67.     <pathname> <Hz>
  68.     ...
  69.     <pathname> <Hz>
  70.  
  71. where <pathname> is the the name of a sample file and <Hz> is the
  72. playback speed in Hertz (just like with the command line invocation).
  73. Put play.inf in your boot partition.  (I.e., if your AUTO folder is
  74. C:\AUTO, put play.inf in C:\)
  75.  
  76.    Then REBOOT!  (Make sure the volume's turned up so ya can hear it...)
  77.  
  78.  
  79. Specifying an Alternate D/A Device (AUTO Folder)
  80. ------------------------------------------------
  81.  
  82.    QD Play can be configured to play its samples through other D/A devices.  
  83. Currently, the Hippo/Navarone and ST Replay digitizers are supported.  Other 
  84. digitizers will be supported if people send me info on them.
  85.  
  86.    To use an alternate D/A device, put one of the following keywords 
  87. in curly brackets at the beginning or end of your play.inf file:
  88.  
  89.         hippo   replay   ste   dma
  90.  
  91. For example, a play.inf containing
  92.  
  93.     {hippo}
  94.     d:\usr\sounds\zoinks.snd        8000
  95.  
  96. will cause QD Play to play the "zoinks" sound through the Hippo/Navarone 
  97. digitizer attached to your ST's cartidge port.
  98.  
  99.    Type
  100.  
  101.     play d:\usr\sounds\zoinks.snd 8000 -hippo
  102.  
  103. to get the same effect from the desktop or command line.  The "ste" device
  104. uses the STe's D/A 8-bit converter, but uses the MFP chip for the timing
  105. so that samples can be played back at any sample rate (at some cost in
  106. sound quality).  The "dma" device uses standard STe DMA sound, but will
  107. only play at one of the following rates: 
  108.  
  109.     6.25 kHz, 12.5 kHz, 25 kHz, 50 kHz
  110.     
  111. QD Play will choose the closest rate from the list above.
  112.  
  113.  
  114. Specifying an Alternate D/A Device (Command Line)
  115. -------------------------------------------------
  116.  
  117.    The following options select the various supported playback devices:
  118.    
  119.     -hippo:  use Hippo digitizer
  120.     -replay: use ST Replay digitizer
  121.     -ste:    use STe sound, using MFP for timing
  122.     -dma:    use STe sound, using DMA for timing
  123.     
  124. All these except -replay can be abbreviated by their first letters.  The
  125. -replay switch can be minimally abbreviated to -re to distinguish it
  126. from the -r (reverse) option.
  127.  
  128.  
  129. Other Exciting Options
  130. ----------------------
  131.  
  132.    The -q option will prevent QD Play from printing its cheerful greeting
  133. message.  For example,
  134.  
  135.     play d:\usr\sounds\attack.snd 11000 -q
  136.  
  137. will play attack.snd without printing a blurb. 
  138.  
  139.    The -r option will cause QD Play to play the sound in reverse.
  140.    
  141.    The -l option tells QD Play to loop the sample either 10 times or
  142. until a key is pressed.  CAVEAT:  Do NOT try this with samples faster
  143. than about 16 kHz using the ST speaker for playback.  Beyond 16 kHz the
  144. sample playing interrupts happen so often that they make the TOS keyboard
  145. handler flakey, which often results in TOTAL SYSTEM LOCKUP.  (And
  146. lots of bombs and other cool stuff on the screen.)
  147.  
  148.    The -2 option makes QD Play interpret the sample data as stereo, where
  149. alternating bytes go to the left and right channels.  Note that you can play
  150. stereo sounds on any device, but on mono devices the two channels will be
  151. mixed.  This usually sounds bad if the stereo sample has panning effects.
  152.  
  153.    The -z option tells QD Play to interpret the sample data as
  154. signed magnitude instead of the standard (as far as I'm concerned
  155. at least) unsigned magnitude.  Some sample editors use signed and
  156. others use unsigned -- it makes no difference in terms of sound
  157. quality, but it's really annoying if you don't have a sample player
  158. that supports both.  If you play a sample and it sounds really noisy,
  159. try the -z option -- you may have a signed magnitude sample on your hands.
  160.  
  161.    
  162. Command Line Usage Examples
  163. ---------------------------
  164.  
  165.    Since QD Play's many options can be a bit daunting at first, here
  166. are some examples to get you started quickly:
  167.  
  168. play chord.110 11000
  169.     
  170.     Plays chord.110 at 11000 hertz through the ST speaker, using
  171.    the MFP for timing.    
  172.  
  173. play stereo.125 12500 -2 -d
  174.     
  175.     Plays stereo.125 at 12500 hertz through the STe 8-bit D/A using DMA,
  176.    treating the data as stereo.    
  177.  
  178. play stereo.125 10000 -2 -d
  179.  
  180.     Same effect as above.  If you don't pick one of the STe DMA device's
  181.    four preset playback rates, QD Play will pick the closest one for you.
  182.    
  183. play stereo.125 10000 -2 -s
  184.  
  185.     Unlike the example above, this command will actually play the
  186.    stereo sound at 10000 hertz, not 12500, since the -s option tells QD Play
  187.    to use the STe 8-bit D/A but to use the MFP for timing.  Sound quality
  188.    is not as good with this method, but unlike the -d option (DMA sound device
  189.    timing) it offers playback at all sample rates. 
  190.  
  191. play signed.080 8000 -z -re
  192.  
  193.     Plays signed.080 at 8000 hertz through the ST Replay digitizer,
  194.    treating the data as signed magnitude.
  195.  
  196. play stereo.125 8000 -2
  197.  
  198.     Plays stereo.125 at 8000 hertz through the ST speaker.  The data
  199.    is interpreted as stereo, but the two channels are mixed to produce
  200.    mono data suitable for the ST speaker (since the ST speaker can't
  201.    play stereo sounds).
  202.  
  203. play deadjim.110 11000 -q -l -hippo
  204.  
  205.     Loops deadjim.110 at 11000 hertz either 10 times or until a
  206.    key is pressed.  No greeting message is printed, and the Hippo/Navaron
  207.    digitizer is used as the output device. 
  208.  
  209. play rooster.080 8000 -r -re
  210.  
  211.     Plays rooster.080 at 8000 hertz in reverse through the ST Replay
  212.    digitizer.  Note that the -replay option can't be abbreviated to -r
  213.    because -r means "play the sample in reverse." 
  214.  
  215. play chord.110 22000 -l
  216.  
  217.     If run on an unaccelerated ST, locks up your machine.  22000 hertz is
  218.    too fast for a looped sample on an unmodified ST.  Keep looped samples
  219.    down below 16 kHz to be safe.
  220.  
  221.  
  222. Miscellaneous Info About Samples and the ST
  223. -------------------------------------------
  224.  
  225.    A sanity-preserving convention I've come up with after dealing with
  226. literally thousands of samples is to store the sample rate in the filename
  227. extension.  E.g.,
  228.  
  229.     filename.110 -> 11.0 kHz -> 11000 Hz
  230.     filaname.123 -> 12.3 kHz -> 12300 Hz
  231.     filename.062 ->  6.2 kHz ->  6200 Hz
  232.     
  233. It helps a lot, since sample speed is not normally encoded in the samples
  234. themselves.  (Sample editing programs usually have their own sample format,
  235. but the most compatbile format is still the raw data.)
  236.  
  237.    Most stereo samples for the STe will be in signed magnitude format,
  238. since is what the device expects.  This means you'll have to use the
  239. -z option to play STe samples created with most other programs.  It
  240. also means that most STe sound players won't play sounds that are
  241. in the standard unsigned format.
  242.  
  243.    Most Mac samples are recored at either 11000 Hz or 22000 Hz.  These
  244. two sample rates are very popular because they're approximately one quarter
  245. and one half the standard rate used on compact discs.
  246.    
  247.    Most ST samples are recored at one of the following speeds:
  248.  
  249.           0 -  4.9  kHz
  250.           1 -  7.68 kHz
  251.           2 -  9.6  kHz
  252.           3 - 14.99 kHz
  253.           4 - 19.8  kHz
  254.           5 - 30.7  kHz
  255.  
  256.    Samples converted from SparcStations will be 8kHz samples.
  257.    
  258.  
  259. History
  260. ------- 
  261.  
  262.    In version 1.0, playback speed was limited to 18kHz.  In version
  263. 1.1, the limit is about 21kHz.  Most 22kHz samples sound OK when
  264. played at 21kHz.
  265.  
  266.    A bug in the sample loading routine has been corrected.  I was
  267. passing a bad argument to calloc.  Who knows why it worked before,
  268. but it's fixed now. 
  269.  
  270.    Also, calling play.ttp with only one argument caused a bus error.
  271. That's been fixed.  
  272.  
  273.    Low sample playback speeds are now handled correctly.  Playback
  274. speeds as low as 600Hz work now. 
  275.  
  276.    As of version 1.25, there was a 25 sample limit.  That limit has
  277. been raised to 250 in version 1.3.     
  278.  
  279.    Version 1.4 saw the addition of the -r option to play samples
  280. in reverse.
  281.    
  282.    Versions 1.5 and 1.6 were only distributed to people who registered
  283. Digital Keyclick.  (If you haven't, please do!)
  284.  
  285.    Version 1.7 saw the addition of the -replay option to play samples
  286. through an ST Replay digitizer.
  287.  
  288.    Version 2.0 was the first to include support for STe's enhanced
  289. sound capabilities.  Other options were added, too, including
  290. looping and signed magnitude sample support.
  291.  
  292. Dave Baggett
  293. 5640 Vantage Point Road
  294. Columbia, MD 21044  USA
  295. Internet: dmb@tis.com or dmb@wam.umd.edu
  296.  
  297. v1.0    April 6, 1990
  298. v1.1    April 29, 1990
  299. v1.25    May 17, 1990
  300. v1.3    July 11, 1990
  301. v1.4    August 5, 1990
  302. v1.7    July 23, 1991
  303. v2.0    March 15, 1992
  304.